package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.AttendPeriodStatAddDTO;
import org.jsola.hr.dto.AttendPeriodStatUpdateDTO;
import org.jsola.hr.query.AttendPeriodStatQuery;
import org.jsola.hr.vo.AttendPeriodStatListVO;
import org.jsola.hr.vo.AttendPeriodStatVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-考勤打卡时间段统计")
public interface IAttendPeriodStatControllerAPI {

    /**
     * 新增考勤打卡时间段统计
     * @param attendPeriodStatAddDTO 考勤打卡时间段统计新增实体
     * @return 考勤打卡时间段统计展示对象
     */
    @ApiOperation(value = "新增考勤打卡时间段统计")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPeriodStatAddDTO", dataType = "AttendPeriodStatAddDTO", value = "新增考勤打卡时间段统计", paramType = "body")
    })
    Result<AttendPeriodStatVO> save(AttendPeriodStatAddDTO attendPeriodStatAddDTO);


    /**
     * 修改考勤打卡时间段统计
     * @param attendPeriodStatUpdateDTO 考勤打卡时间段统计
     * @return 更新数量
     */
    @ApiOperation(value = "修改考勤打卡时间段统计")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPeriodStatUpdateDTO", dataType = "AttendPeriodStatUpdateDTO", value = "修改考勤打卡时间段统计", paramType = "body")
    })
    Result<Integer> update(AttendPeriodStatUpdateDTO attendPeriodStatUpdateDTO);




    /**
     * 删除单个考勤打卡时间段统计，彻底删除
     * @param attendPeriodStatId 考勤打卡时间段统计id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个考勤打卡时间段统计，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPeriodStatId", dataType = "String", value = "考勤打卡时间段统计id", paramType = "path")
    })
    Result<Integer> delete(String attendPeriodStatId);


    /**
     * 批量删除考勤打卡时间段统计，彻底删除
     * @param attendPeriodStatIds 考勤打卡时间段统计id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除考勤打卡时间段统计，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPeriodStatIds", dataType = "String[]", value = "考勤打卡时间段统计id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] attendPeriodStatIds);


    /**
     * 根据考勤打卡时间段统计id查询考勤打卡时间段统计详情
     * @param attendPeriodStatId 考勤打卡时间段统计id
     * @return 考勤打卡时间段统计详情
     */
    @ApiOperation(value="根据考勤打卡时间段统计id查询考勤打卡时间段统计详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPeriodStatId", dataType = "String", value = "考勤打卡时间段统计id", paramType = "path")
    })
    Result<AttendPeriodStatVO> findById(String attendPeriodStatId);


    /**
     * 查询考勤打卡时间段统计
     * @param attendPeriodStatQuery 考勤打卡时间段统计查询参数
     * @return page
     */
    @ApiOperation(value="查询考勤打卡时间段统计")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPeriodStatQuery", dataType = "AttendPeriodStatQuery", value = "考勤打卡时间段统计查询参数", paramType = "query")
    })
    Result<List<AttendPeriodStatListVO>> listAll(AttendPeriodStatQuery attendPeriodStatQuery);


     /**
     * 分页查询考勤打卡时间段统计
     * @param attendPeriodStatQuery 考勤打卡时间段统计查询参数
     * @return page
     */
    @ApiOperation(value="分页查询考勤打卡时间段统计")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendPeriodStatQuery", dataType = "AttendPeriodStatQuery", value = "考勤打卡时间段统计查询参数", paramType = "query")
    })
    Result<Page<AttendPeriodStatListVO>> page(AttendPeriodStatQuery attendPeriodStatQuery);


}

